Documentation fixes

svn path=/trunk/; revision=18151

diff --git a/ChangeLog b/ChangeLog
index b10374e1e0d8836fc2cadfb7e722282dddfdad46..be46d8bef3a37c0730f6a4f9192e6a1a2d968a6f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2007-06-15  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkbuildable.c:
+       * gtk/gtkbuilder.c: Documentation fixes
+
        * gtk/gtktreeview.c: Fix up cross-references in docs.
        
        * gtk/Makefile.am: Don't install gtkbuilderprivate.h

diff --git a/gtk/gtkbuildable.c b/gtk/gtkbuildable.c
index ee3934ec27adc9c617b24570abcd0a2718ceef8d..acac25fe8246d5e90b47ca4eaebd5feb373cfb75 100644 (file)
--- a/gtk/gtkbuildable.c
+++ b/gtk/gtkbuildable.c
@@ -75,12 +75,15 @@ gtk_buildable_set_name (GtkBuildable *buildable,
  * gtk_buildable_get_name:
  * @buildable: a #GtkBuildable
  *
- * Returns: the buildable name, the name which was set in
- * the <link linkend="BUILDER-UI">GtkBuilder UI definition</link> used to
- * construct the @buildable.
+ *   
+ * Returns the buildable name. #GtkBuilder sets the name based on the 
+ * the <link linkend="BUILDER-UI">GtkBuilder UI definition</link> used 
+ * to construct the @buildable.
  *
  * #GtkWidget implements this to map the buildable name to the widget name
  *
+ * Returns: the name set with gtk_buildable_set_name()
+ *
  * Since: 2.12
  **/
 const gchar *
@@ -206,9 +209,12 @@ gtk_buildable_parser_finished (GtkBuildable *buildable,
  *
  * Construct a child of @buildable with the name @name.
  *
- * #GtkUIManager implements this to reference to a widget created in a &lt;ui&gt; tag
- * which is outside of the normal <link linkend="BUILDER-UI">GtkBuilder UI definition</link>
- * object hierarchy.
+ * #GtkUIManager implements this to reference to a widget created in a 
+ * &lt;ui&gt; tag which is outside of the normal 
+ * <link linkend="BUILDER-UI">GtkBuilder UI definition</link>
+ * hierarchy.
+ *
+ * Returns: the child with name @name
  *
  * Since: 2.12
  **/
@@ -344,9 +350,9 @@ gtk_buildable_custom_finished (GtkBuildable  *buildable,
  * @builder: a #GtkBuilder
  * @childname: name of child
  *
- * Get the internal child called @child of the @buildable object.
+ * Get the internal child called @childname of the @buildable object.
  *
- * Return: the internal child of the buildable object
+ * Returns: the internal child of the buildable object 
  *
  * Since: 2.12
  **/

diff --git a/gtk/gtkbuilder.c b/gtk/gtkbuilder.c
index 63b2f09a2838a873f0800917c94b61e90ad7d669..72632bf46cf2c3483d55ee1811e0c8392fcce2fc 100644 (file)
--- a/gtk/gtkbuilder.c
+++ b/gtk/gtkbuilder.c
@@ -673,7 +673,10 @@ gtk_builder_add_from_string (GtkBuilder   *builder,
  * @builder: a #GtkBuilder
  * @name: name of object to get
  *
- * Return value: GObject or %NULL if it could not be found in the object tree.
+ * Gets the object named @name.
+ *
+ * Return value: the object named @name or %NULL if it could not be 
+ *    found in the object tree
  *
  * Since: 2.12
  **/
@@ -699,8 +702,10 @@ object_add_to_list (gchar *object_id,
  * gtk_builder_get_objects:
  * @builder: a #GtkBuilder
  *
+ * Gets all objects that have been constructed by @builder.
+ *
  * Return value: a newly-allocated #GSList containing all the objects
- *   constructed by GtkBuilder instance.
+ *   constructed by the #GtkBuilder instance
  *
  * Since: 2.12
  **/
@@ -747,7 +752,9 @@ gtk_builder_set_translation_domain (GtkBuilder  *builder,
  * gtk_builder_get_translation_domain:
  * @builder: a #GtkBuilder
  *
- * Return value : the translation domain. This string is owned
+ * Gets the translation domain.
+ *
+ * Return value: the translation domain. This string is owned
  * by the builder object and must not be modified or freed.
  *
  * Since: 2.12
@@ -1231,10 +1238,13 @@ _gtk_builder_flags_from_string (GType type, const char *string)
 /**
  * gtk_builder_get_type_from_name:
  * @builder: a #GtkBuilder
- * @typename: Type name to lookup.
+ * @typename: Type name to lookup
+ *
+ * This method is used to lookup a type. It can be implemented in a 
+ * subclass to override the #GType of an object created by the builder.
  *
- * This method is used to lookup a type. It can be implemented in a subclass to
- * override the #GType of an object created by the builder.
+ * Returns: the #GType found for @typename or #G_TYPE_INVALID if no
+ *   type was found
  *
  * Since 2.12
  */